GenericNode.java

/*******************************************************************************
 * Signavio Core Components
 * Copyright (C) 2012  Signavio GmbH
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package org.oryxeditor.server.diagram.generic;

import java.util.List;

import org.oryxeditor.server.diagram.Point;
import org.oryxeditor.server.diagram.exception.TooManyDockersException;

/**
 * Represents a node element in a diagram. Nodes may only have at most one docker. 
 * 
 * @author Philipp Maschke, Robert Gurol
 *
 * @param <S> the actual type of shape to be used (must inherit from {@link GenericShape}); calls to {@link #getChildShapesReadOnly()}, ... will return this type
 * @param <D> the actual type of diagram to be used (must inherit from {@link GenericDiagram}); {@link #getDiagram()} will return this type
 */
public abstract class GenericNode<S extends GenericShape<S,D>, D extends GenericDiagram<S,D>> extends GenericShapeImpl<S,D> {

	public GenericNode(String resourceId) {
		super(resourceId);
	}

	public GenericNode(String resourceId, String stencilId) {
		super(resourceId, stencilId);
	}

	
	/**
	 * Sets the given docker as the nodes docker.
	 * 
	 * @param p
	 * @throws TooManyDockersException if the node already has a docker (nodes may only have one docker)
	 */
	@Override
	public void addDocker(Point p) throws TooManyDockersException {
		if (!getDockersReadOnly().isEmpty())
			throw new TooManyDockersException("Trying to set more than 1 docker for node '" + getResourceId() + "'");
		super.addDocker(p);
	}

	/**
	 * Sets the given docker as the nodes docker.
	 * 
	 * @param p
	 * @param position
	 * @throws TooManyDockersException if the node already has a docker (nodes may only have one docker)
	 */
	@Override
	public void addDocker(Point p, int position) {
		if (!getDockersReadOnly().isEmpty())
			throw new TooManyDockersException("Trying to set more than 1 docker for node '" + getResourceId() + "'");
		
		super.addDocker(p, position);
	}

	/**
	 * Sets the given list of dockers as the nodes dockers.
	 * <p>
	 * <b>Beware:</b> Nodes may only have one docker -> the given list may only have 0 or 1 points or an exception will be thrown
	 * 
	 * @param dockers list containing 0 or 1 docker
	 * @throws TooManyDockersException if p is not null and the node already has a docker (nodes may only have one docker)
	 */
	@Override
	public void setDockers(List<Point> dockers) {
		if (dockers != null && dockers.size() > 1)
			throw new TooManyDockersException("Trying to set more than 1 docker for node '" + getResourceId() + "'");
		
		super.setDockers(dockers);
	}

	// TODO do the other operations actually make sense / have to be redefined
	// here?

}